home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 26 / AACD 26.iso / AACD / Programming / wfimage / src / developer / waveforms.doc < prev   
Encoding:
Text File  |  2001-09-13  |  3.1 KB  |  84 lines
  1.  
  2.  
  3. /****** waveforms.image/--datasheet-- ***********************************************
  4. *
  5. *    NAME
  6. *       waveforms.image--Audio Waveforms display images.                 (V0)
  7. *
  8. *    SUPERCLASS
  9. *       imageclass
  10. *
  11. *    DESCRIPTION
  12. *       The waveforms.image class provides a selectable waveform image display.
  13. *
  14. *    METHODS
  15. *       OM_NEW--Create the waveforms.  Passed to superclass, then OM_SET.
  16. *
  17. *       OM_SET--Set object attributes.  Passed to superclass first.
  18. *
  19. *       OM_GET--Get object attributes.  Passed to superclass first.
  20. *
  21. *       OM_UPDATE--Set object notification attributes.  Passed to superclass
  22. *           first.
  23. *
  24. *       IM_DRAW--Renders the images.  Overrides the superclass.
  25. *
  26. *       All other methods are passed to the superclass, including OM_DISPOSE.
  27. *
  28. *    ATTRIBUTES
  29. *
  30. *       SYSIA_DrawInfo (struct DrawInfo *) -- Contains important pen                 IS
  31. *           information.  This is required if IA_BGPen and IA_FGPen are
  32. *           not specified.
  33. *
  34. *       IA_Pens -- pointer to UWORD pens[]                                           IS
  35. *
  36. *       IA_FGPen (LONG) -- Pen to use to draw the hilite box outline or BLOCKPEN.    IS
  37. *
  38. *       IA_BGPen (LONG) -- Pen to use to draw the shadow box outline or DETAILPEN.   IS
  39. *
  40. *       IA_Width (WORD) -- Width of the image - def 64 pixels.                       IS
  41. *
  42. *       IA_Height (WORD) -- Height of the image - def 64 pixels.                     IS
  43. *
  44. *
  45. *    Private Tags:
  46. *
  47. *       WFI_WaveType (LONG) -- Which of the 5 types of waveforms is used.            ISG
  48. *
  49. *              WF_SINE_WAVE         0
  50. *              WF_TRIANGULAR_WAVE   1
  51. *              WF_RAMPUP_WAVE       2
  52. *              WF_RAMPDOWN_WAVE     3
  53. *              WF_SQUARE_WAVE       4
  54. *
  55. *       WFI_WaveShape (LONG) -- Pulse width for square wave only. Values can be      ISG
  56. *                                             from -98 to +98.
  57. *
  58. *       WFI_Outline (LONG) -- Draw the wave either as WF_SOLID_DISPLAY               ISG
  59. *                                                  or as WF_DOTTED_DISPLAY
  60. *
  61. *       WFI_BoxFrame (LONG) -- Draw a box frame around the graphic or none           IS
  62. *                                   the graphic will be adjusted to fit inside
  63. *
  64. *       WFI_OsciPen (WORD) -- Pen to use to draw the 'oscilloscope screen'           ISG
  65. *                                   background.  If -1 is specified then
  66. *                                   BARBLOCKPEN is used.
  67. *
  68. *       WFI_WavePen (WORD) -- Pen to use to draw the wave.  If -1 is                 IS
  69. *                                   specified then BARDETAILPEN is used.
  70. *
  71. *       WFI_ZeroPen (WORD) -- Draw the zero line using this colour.  The             ISG
  72. *                                   zero line is only drawn when the option
  73. *                                   WF_DOTTED_DISPLAY is selected.  Defaults
  74. *                                   to WF_OsciPen for 'invisible' line or to
  75. *                                   BARTRIMPEN if -1 is specified.
  76. *
  77. *
  78. *******************************************************************************
  79. *
  80. *  P. Juhasz - paul@sufo.estates.co.uk - http://www.sufo.estates.co.uk
  81. *
  82. */
  83.  
  84.